Skip to content

Conversation

@xrissoula
Copy link
Contributor

@xrissoula xrissoula commented Mar 21, 2025

Description

This PR adds eight new reference documents and updates the sidebar to include them under the “Architecture” section of the “Reference” category. It also fixes the last PR for these documents, which was submitted with incorrect branch naming.

Additionally, the documents have been formatted and linted to comply with repository standards.
Relates Issue #262

New Documents Added:

  • docs/reference/DES.md
  • docs/reference/ecis.md
  • docs/reference/encryption-algorithms.md
  • docs/reference/hybrid-cryptosystem.md
  • docs/reference/json-webx-standards.md
  • docs/reference/kem.md
  • docs/reference/key-encryption-management-storage.md
  • docs/reference/node-id.md

Sidebar Update:

  • The above documents were added under Reference > Architecture in sidebars.ts

Reason for Changes

  • These documents are necessary for expanding the reference section with additional encryption-related documentation.
  • The sidebar update ensures they are accessible in the documentation UI.
  • The previous versions of these documents were not correctly formatted, so this update includes lint fixes and formatting corrections.

Previous PR Context

  • These documents have been part of earlier discussions and were initially added without full linting compliance.
  • This PR ensures they adhere to markdownlint standards while also making them visible in the Docusaurus sidebar.

Testing

  • The Docusaurus local server (npm run start) was used to verify that the documents render correctly and are properly linked in the sidebar.

Issues Fixed

Tasks

  • 1. Format and lint the eight reference documents
  • 2. Ensure proper Docusaurus rendering for new documents
  • 3. Update sidebars.ts to include new documents under Reference > Architecture
  • 4. Verify sidebar updates reflect correctly in local Docusaurus build
  • 5. Commit changes using feat: in conventional commits
  • 6. Push changes and open PR

Final checklist

  • Domain specific tests
  • Full tests
  • Updated inline-comment documentation
  • Lint fixed
  • Squash and rebased
  • Sanity check the final build

@xrissoula xrissoula requested a review from aryanjassal March 21, 2025 07:45
@xrissoula xrissoula self-assigned this Mar 21, 2025
@xrissoula xrissoula mentioned this pull request Mar 21, 2025
12 tasks
@CMCDragonkai
Copy link
Member

@CMCDragonkai
Copy link
Member

This is a high priority to review and merge. @aryanjassal

@aryanjassal aryanjassal force-pushed the feature-update-reference branch from 06acf96 to dbb619d Compare March 24, 2025 06:05
@aryanjassal
Copy link
Contributor

Okay, I've reworked this to align with the requirements. There were just some minor changes needed here and there, so they have been made and now it is ready for merge. Christina has also gone through this once and she's given her approval for this as well.

@aryanjassal aryanjassal merged commit e1d2058 into staging Mar 24, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants